Create journal entry

curl --request POST \
  --url https://api.hyperline.co/v1/accounting/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ledger_id": "<string>",
  "description": "<string>",
  "entry_date_at": "2023-12-25",
  "lines": [
    {
      "ledger_account_id": "<string>",
      "amount": "<string>"
    }
  ],
  "recognition_schedule": {
    "revenue_ledger_account_id": "<string>",
    "recognition_date": "2023-12-25",
    "window": {
      "start_date": "2023-12-25",
      "end_date": "2023-12-25"
    }
  }
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/journal-entries"

payload = {
    "ledger_id": "<string>",
    "description": "<string>",
    "entry_date_at": "2023-12-25",
    "lines": [
        {
            "ledger_account_id": "<string>",
            "amount": "<string>"
        }
    ],
    "recognition_schedule": {
        "revenue_ledger_account_id": "<string>",
        "recognition_date": "2023-12-25",
        "window": {
            "start_date": "2023-12-25",
            "end_date": "2023-12-25"
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ledger_id: '<string>',
    description: '<string>',
    entry_date_at: '2023-12-25',
    lines: [{ledger_account_id: '<string>', amount: '<string>'}],
    recognition_schedule: {
      revenue_ledger_account_id: '<string>',
      recognition_date: '2023-12-25',
      window: {start_date: '2023-12-25', end_date: '2023-12-25'}
    }
  })
};

fetch('https://api.hyperline.co/v1/accounting/journal-entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/accounting/journal-entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ledger_id' => '<string>',
    'description' => '<string>',
    'entry_date_at' => '2023-12-25',
    'lines' => [
        [
                'ledger_account_id' => '<string>',
                'amount' => '<string>'
        ]
    ],
    'recognition_schedule' => [
        'revenue_ledger_account_id' => '<string>',
        'recognition_date' => '2023-12-25',
        'window' => [
                'start_date' => '2023-12-25',
                'end_date' => '2023-12-25'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/journal-entries"

	payload := strings.NewReader("{\n  \"ledger_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"entry_date_at\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"ledger_account_id\": \"<string>\",\n      \"amount\": \"<string>\"\n    }\n  ],\n  \"recognition_schedule\": {\n    \"revenue_ledger_account_id\": \"<string>\",\n    \"recognition_date\": \"2023-12-25\",\n    \"window\": {\n      \"start_date\": \"2023-12-25\",\n      \"end_date\": \"2023-12-25\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/accounting/journal-entries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ledger_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"entry_date_at\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"ledger_account_id\": \"<string>\",\n      \"amount\": \"<string>\"\n    }\n  ],\n  \"recognition_schedule\": {\n    \"revenue_ledger_account_id\": \"<string>\",\n    \"recognition_date\": \"2023-12-25\",\n    \"window\": {\n      \"start_date\": \"2023-12-25\",\n      \"end_date\": \"2023-12-25\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/journal-entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ledger_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"entry_date_at\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"ledger_account_id\": \"<string>\",\n      \"amount\": \"<string>\"\n    }\n  ],\n  \"recognition_schedule\": {\n    \"revenue_ledger_account_id\": \"<string>\",\n    \"recognition_date\": \"2023-12-25\",\n    \"window\": {\n      \"start_date\": \"2023-12-25\",\n      \"end_date\": \"2023-12-25\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "entry_number": "<string>",
  "posted_at": "2023-12-25",
  "entry_date_at": "2023-12-25",
  "original_currency": "<string>",
  "original_currency_exchange_rate": "<string>",
  "original_currency_exchange_rate_date": "2023-12-25",
  "amount": "<string>",
  "amount_in_original_currency": "<string>",
  "description": "<string>",
  "invoicing_entity_id": "<string>",
  "ledger_id": "<string>",
  "invoice_id": "<string>",
  "customer_id": "<string>",
  "invoice_line_item_id": "<string>",
  "subscription_id": "<string>",
  "transaction_id": "<string>",
  "reversal_for_entry_id": "<string>",
  "lines": [
    {
      "id": "<string>",
      "line_number": 123,
      "date": "2023-12-25",
      "description": "<string>",
      "amount": "<string>",
      "amount_in_original_currency": "<string>",
      "original_currency": "<string>",
      "original_currency_exchange_rate": "<string>",
      "original_currency_exchange_rate_date": "2023-12-25",
      "entry_id": "<string>",
      "ledger_account_id": "<string>",
      "invoice_line_item_id": "<string>",
      "rule_id": "<string>",
      "rule_code": "<string>",
      "rule_name": "<string>",
      "product_id": "<string>",
      "invoicing_entity_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25",
      "entry_posted_at": "2023-12-25",
      "entry_number": "<string>",
      "account_code_snapshot": "<string>",
      "account_name_snapshot": "<string>"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "schedule_id": "<string>"
}

POST

accounting

journal-entries

Create journal entry

curl --request POST \
  --url https://api.hyperline.co/v1/accounting/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ledger_id": "<string>",
  "description": "<string>",
  "entry_date_at": "2023-12-25",
  "lines": [
    {
      "ledger_account_id": "<string>",
      "amount": "<string>"
    }
  ],
  "recognition_schedule": {
    "revenue_ledger_account_id": "<string>",
    "recognition_date": "2023-12-25",
    "window": {
      "start_date": "2023-12-25",
      "end_date": "2023-12-25"
    }
  }
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/journal-entries"

payload = {
    "ledger_id": "<string>",
    "description": "<string>",
    "entry_date_at": "2023-12-25",
    "lines": [
        {
            "ledger_account_id": "<string>",
            "amount": "<string>"
        }
    ],
    "recognition_schedule": {
        "revenue_ledger_account_id": "<string>",
        "recognition_date": "2023-12-25",
        "window": {
            "start_date": "2023-12-25",
            "end_date": "2023-12-25"
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ledger_id: '<string>',
    description: '<string>',
    entry_date_at: '2023-12-25',
    lines: [{ledger_account_id: '<string>', amount: '<string>'}],
    recognition_schedule: {
      revenue_ledger_account_id: '<string>',
      recognition_date: '2023-12-25',
      window: {start_date: '2023-12-25', end_date: '2023-12-25'}
    }
  })
};

fetch('https://api.hyperline.co/v1/accounting/journal-entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/accounting/journal-entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ledger_id' => '<string>',
    'description' => '<string>',
    'entry_date_at' => '2023-12-25',
    'lines' => [
        [
                'ledger_account_id' => '<string>',
                'amount' => '<string>'
        ]
    ],
    'recognition_schedule' => [
        'revenue_ledger_account_id' => '<string>',
        'recognition_date' => '2023-12-25',
        'window' => [
                'start_date' => '2023-12-25',
                'end_date' => '2023-12-25'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/journal-entries"

	payload := strings.NewReader("{\n  \"ledger_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"entry_date_at\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"ledger_account_id\": \"<string>\",\n      \"amount\": \"<string>\"\n    }\n  ],\n  \"recognition_schedule\": {\n    \"revenue_ledger_account_id\": \"<string>\",\n    \"recognition_date\": \"2023-12-25\",\n    \"window\": {\n      \"start_date\": \"2023-12-25\",\n      \"end_date\": \"2023-12-25\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/accounting/journal-entries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ledger_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"entry_date_at\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"ledger_account_id\": \"<string>\",\n      \"amount\": \"<string>\"\n    }\n  ],\n  \"recognition_schedule\": {\n    \"revenue_ledger_account_id\": \"<string>\",\n    \"recognition_date\": \"2023-12-25\",\n    \"window\": {\n      \"start_date\": \"2023-12-25\",\n      \"end_date\": \"2023-12-25\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/journal-entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ledger_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"entry_date_at\": \"2023-12-25\",\n  \"lines\": [\n    {\n      \"ledger_account_id\": \"<string>\",\n      \"amount\": \"<string>\"\n    }\n  ],\n  \"recognition_schedule\": {\n    \"revenue_ledger_account_id\": \"<string>\",\n    \"recognition_date\": \"2023-12-25\",\n    \"window\": {\n      \"start_date\": \"2023-12-25\",\n      \"end_date\": \"2023-12-25\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "entry_number": "<string>",
  "posted_at": "2023-12-25",
  "entry_date_at": "2023-12-25",
  "original_currency": "<string>",
  "original_currency_exchange_rate": "<string>",
  "original_currency_exchange_rate_date": "2023-12-25",
  "amount": "<string>",
  "amount_in_original_currency": "<string>",
  "description": "<string>",
  "invoicing_entity_id": "<string>",
  "ledger_id": "<string>",
  "invoice_id": "<string>",
  "customer_id": "<string>",
  "invoice_line_item_id": "<string>",
  "subscription_id": "<string>",
  "transaction_id": "<string>",
  "reversal_for_entry_id": "<string>",
  "lines": [
    {
      "id": "<string>",
      "line_number": 123,
      "date": "2023-12-25",
      "description": "<string>",
      "amount": "<string>",
      "amount_in_original_currency": "<string>",
      "original_currency": "<string>",
      "original_currency_exchange_rate": "<string>",
      "original_currency_exchange_rate_date": "2023-12-25",
      "entry_id": "<string>",
      "ledger_account_id": "<string>",
      "invoice_line_item_id": "<string>",
      "rule_id": "<string>",
      "rule_code": "<string>",
      "rule_name": "<string>",
      "product_id": "<string>",
      "invoicing_entity_id": "<string>",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25",
      "entry_posted_at": "2023-12-25",
      "entry_number": "<string>",
      "account_code_snapshot": "<string>",
      "account_name_snapshot": "<string>"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "schedule_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

ledger_id

string

required

Ledger identifier.

description

string

required

Description recorded on the manual journal entry.

Required string length: 1 - 500

entry_date_at

string<date> | null

required

Timestamp when the journal entry takes effect.

lines

object[]

required

Balanced debit and credit lines.

Minimum array length: 2

Show child attributes

recognition_schedule

object | null

Optional recognition schedule for a deferred-revenue credit.

Show child attributes

Response

string

required

Unique journal-entry identifier.

entry_number

string

required

Human-readable journal-entry number.

posted_at

string<date> | null

required

Timestamp when the entry was posted.

entry_date_at

string<date> | null

required

Accounting timestamp of the entry.

original_currency

string

required

ISO 4217 original currency.

original_currency_exchange_rate

string

required

Exchange rate into ledger currency.

original_currency_exchange_rate_date

string<date> | null

required

Date of the exchange rate.

amount

string

required

Total amount in ledger currency.

amount_in_original_currency

string

required

Total amount in the original currency.

description

string | null

required

Optional journal-entry description.

status

enum<string>

required

Journal-entry status.

Available options:

draft,

posted

origin

enum<string>

required

Automatic or manual entry origin.

Available options:

auto,

manual

invoicing_entity_id

string

required

Owning invoicing entity identifier.

ledger_id

string

required

Owning ledger identifier.

invoice_id

string | null

required

Related invoice identifier.

customer_id

string | null

required

Related customer identifier.

invoice_line_item_id

string | null

required

Related invoice line-item identifier.

subscription_id

string | null

required

Related subscription identifier.

transaction_id

string | null

required

Related payment transaction identifier.

reversal_for_entry_id

string | null

required

Original entry identifier when this is a reversal.

lines

object[]

required

Debit and credit lines in the entry.

Show child attributes

created_at

string<date> | null

required

Timestamp when the entry was created.

updated_at

string<date> | null

required

Timestamp when the entry was last updated.

schedule_id

string | null

Revenue-recognition schedule created with a manual entry.

⌘I